/*
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.exadel.aem.toolkit.api.annotations.widgets.rte;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.exadel.aem.toolkit.api.annotations.meta.AnnotationRendering;
import com.exadel.aem.toolkit.api.annotations.meta.ValueRestriction;
import com.exadel.aem.toolkit.api.annotations.meta.ValueRestrictions;

/**
 * Used to set up an entry in {@link RichTextEditor#icons()} array. Represents a matching between an RTE command
 * (a "feature"), and an icon to be displayed for this command on the RTE toolbar
 * @see RichTextEditor
 */
@Target({})
@Retention(RetentionPolicy.RUNTIME)
@ValueRestriction(ValueRestrictions.ALL_NOT_BLANK)
@AnnotationRendering(properties = "all")
public @interface IconMapping {

    /**
     * Represents the command token
     * @return String value, non-blank
     */
    String command();

    /**
     * Represents the icon token
     * @return String value, non-blank
     */
    String icon();
}
